Dokumentacja MAIL REST API 1.0

PUT aliases/<domain>/<name>

Opis
Modyfikacja jednego lub wielu aliasów pocztowych.
Sygnatura polecenia
  • Metoda żądania - PUT
  • Ścieżka żądania (URL PATH) - parametry identyfikujące alias pocztowy (lub wiele aliasów w ramach jednej domeny)
  • Ciało żądania - wszystkie lub wybrane parametry modyfikujące jeden lub wiele aliasów pocztowych
  • Ciało odpowiedzi
    • modyfikacja jednego aliasu - wszystkie parametry opisujące alias pocztowy
    • modyfikacja wielu aliasów - puste
Parametry ścieżki:
(string) domain
wymagany Nazwa domeny w obrębie której znajduje się edytowany alias.
przykładowa wartość: demo.kei.pl
(string) name
wymagany Nazwa aktualizowanego aliasu pocztowego. Aby jednocześnie zmodyfikować wiele aliasów we wskazanej domenie należy podać listę nazw aliasów oddzielonych przecinkiem.
przykładowa wartość: aktualizowanyalias
wymagania składniowe:
  • - Tylko małe litery
  • - Pole nie może być puste
  • - Dopuszczone po jednym wystąpieniu w ciągu symboli '/', '.' oraz '-'
  • - Pole może mieć najwyżej 32 znaki / znaków
Parametry modyfikujące:
target Pełny adres e-mail np. stefan@domena.pl.
Konto docelowe to adres e-mail, na który będzie przekierowana poczta wysyłana na adres aliasu.
wymagania składniowe:
  • - Tylko małe litery
  • - Pole nie może być puste
  • - W polu można podać albo poprawną nazwę adresu email (z dopuszczonym znakiem '+' w identyfikatorze użytkownika) lub nazwę konta FTP.
Parametry odpowiedzi:
email Pełen adres pocztowy aliasu.
Przykładowe zapytanie:
PUT https://as27.demo.kei.pl/v1/aliases/demo.kei.pl/aktualizowanyalias
 parametry:
{ "target":"nowycelaliasu@demo.kei.pl" }
Przykładowa odpowiedź:
{
    "name":"aktualizowanyalias",
    "domain":"demo.kei.pl",
    "email":"aktualizowanyalias@demo.kei.pl",
    "target":"nowycelaliasu@demo.kei.pl"
}